Enhance CI workflow with coverage reporting and update README badges by shenxianpeng · Pull Request #2 · commit-check/commit-check-mcp

shenxianpeng · 2026-04-19T19:26:39Z

Summary by CodeRabbit

Documentation
- Added status badges to README displaying PyPI version, Python compatibility, build status, and code coverage metrics.
Chores
- Added test coverage tracking support to development dependencies.
- Enabled automated coverage reporting for continuous integration pipeline.

coderabbitai · 2026-04-19T19:26:53Z

Warning

Rate limit exceeded

@shenxianpeng has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 57 minutes and 37 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 57 minutes and 37 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 56e5ad3d-940c-4dca-bdfd-c915561e5b34

📥 Commits

Reviewing files that changed from the base of the PR and between a4fdc6a and 6e3b539.

📒 Files selected for processing (1)

.github/workflows/labeler.yml

📝 Walkthrough

Walkthrough

Coverage tracking infrastructure is established via pytest-cov in the development dependencies and CI workflow. The test pipeline now collects coverage metrics for src/commit_check_mcp, generates an XML report, and conditionally uploads it to Codecov. Project status badges are added to the README.

Changes

Cohort / File(s)	Summary
Coverage Infrastructure `.github/workflows/main.yml`, `pyproject.toml`	Enabled pytest coverage collection via `pytest-cov` dependency and configured CI workflow to generate XML coverage reports and conditionally upload to Codecov for Python 3.12.
Project Documentation `README.md`	Added status badges for PyPI version, Python version support, GitHub Actions build status, code coverage, and MCP server branding.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A tiny bunny hops with glee,
Coverage badges, clear to see!
Pytest collects what's true and bright,
Codecov shines the testing light,
Metrics dance in XML's delight! 📊✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and accurately reflects the main changes in the PR: adding coverage reporting to the CI workflow (.github/workflows/main.yml) and updating README badges.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch patch-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

🧹 Nitpick comments (1)

.github/workflows/main.yml (1)
40-44: Consider adding a Codecov token and explicit failure behavior.

codecov/codecov-action@v5 supports tokenless uploads for public repos, but these are rate-limited and can produce flaky CI, especially for PRs from forks. Two small improvements worth considering:

Add token: ${{ secrets.CODECOV_TOKEN }} once the repo secret is configured, to get reliable uploads.

Set fail_ci_if_error: false (default) explicitly, or true if coverage upload must block the pipeline — right now the behavior is implicit.
♻️ Example
       - name: Upload coverage
         if: matrix.python-version == '3.12'
         uses: codecov/codecov-action@v5
         with:
           files: ./coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/main.yml around lines 40 - 44, The "Upload coverage" step
using codecov/codecov-action@v5 should explicitly provide a token and explicit
failure behavior: add the input key token with the secret reference
(secrets.CODECOV_TOKEN) and add the input fail_ci_if_error with either "false"
or "true" depending on whether you want uploads to block the CI; update the
Upload coverage step (the step that uses codecov/codecov-action@v5) to include
these inputs so uploads are reliable and CI behavior is explicit.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/main.yml:
- Around line 40-44: The "Upload coverage" step using codecov/codecov-action@v5
should explicitly provide a token and explicit failure behavior: add the input
key token with the secret reference (secrets.CODECOV_TOKEN) and add the input
fail_ci_if_error with either "false" or "true" depending on whether you want
uploads to block the CI; update the Upload coverage step (the step that uses
codecov/codecov-action@v5) to include these inputs so uploads are reliable and
CI behavior is explicit.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e41e558f-25c3-4544-9bc9-bdf2921e3907

📥 Commits

Reviewing files that changed from the base of the PR and between fc7bced and a4fdc6a.

📒 Files selected for processing (3)

.github/workflows/main.yml
README.md
pyproject.toml

Enhance CI workflow with coverage reporting and update README badges

a4fdc6a

coderabbitai bot reviewed Apr 19, 2026

View reviewed changes

Refactor PR autolabeler workflow configuration

6e3b539

github-actions bot added the documentation Improvements or additions to documentation label Apr 19, 2026

shenxianpeng merged commit b3590a9 into main Apr 19, 2026
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance CI workflow with coverage reporting and update README badges#2

Enhance CI workflow with coverage reporting and update README badges#2
shenxianpeng merged 2 commits intomainfrom
patch-1

shenxianpeng commented Apr 19, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 19, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

shenxianpeng commented Apr 19, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

shenxianpeng commented Apr 19, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 19, 2026 •

edited

Loading